<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">

<title>module RubyXL - rubyXL 3.4.35</title>


  <meta name="keywords" content="ruby,module,RubyXL">


    <meta name="description" content="module RubyXL: msdn. microsoft.">





<script type="text/javascript">
  var rdoc_rel_prefix = "./";
  var index_rel_prefix = "./";
</script>

<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>

<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">



<body id="top" role="document" class="module">
<div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
  <span aria-hidden="true">&#9776;</span>
</div>


<nav id="navigation" role="navigation">
  <div id="project-navigation">
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2>
    <a href="./index.html" rel="home">Home</a>
  </h2>

  <div id="table-of-contents-navigation">
    <a href="./table_of_contents.html#pages">Pages</a>
    <a href="./table_of_contents.html#classes">Classes</a>
    <a href="./table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>

  

  

  

  

  

  
  <div class="nav-section">
    <h3>Class Methods</h3>
    <ul class="link-list" role="directory">

      <li ><a href="#method-c-from_root">from_root</a></li>

    </ul>
  </div>





  <footer id="validator-badges" role="contentinfo">
  <p><a href="https://validator.w3.org/check/referer">Validate</a></p>
  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.15.1.</p>
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>
</footer>

</nav>

<main role="main" aria-labelledby="module-RubyXL">
  
  

  <h1 id="module-RubyXL" class="anchor-link module">
    module RubyXL
  </h1>

  <section class="description">
    
<p><a href="RubyXL/Connections.html"><code>Connections</code></a> <a href="https://msdn.microsoft.com/en-us/library/dd908547(v=office.12).aspx">msdn.microsoft.com/en-us/library/dd908547(v=office.12).aspx</a> <a href="http://www.datypic.com/sc/ooxml/s-sml-externalConnections.xsd.html">www.datypic.com/sc/ooxml/s-sml-externalConnections.xsd.html</a></p>

<p>Query Tables <a href="https://msdn.microsoft.com/en-us/library/hh643563(v=office.12).aspx">msdn.microsoft.com/en-us/library/hh643563(v=office.12).aspx</a></p>

  </section>


  <section id="5Buntitled-5D" class="documentation-section anchor-link">





    <section class="constants-list">
      <header>
        <h3>Constants</h3>
      </header>
      <dl>

        <dt id="ST_Axis">ST_Axis</dt>

        <dd>

          
        </dd>


        <dt id="ST_BevelPresetType">ST_BevelPresetType</dt>

        <dd>

          
        </dd>


        <dt id="ST_BlackWhiteMode">ST_BlackWhiteMode</dt>

        <dd>

          
        </dd>


        <dt id="ST_BlendMode">ST_BlendMode</dt>

        <dd>

          
        </dd>


        <dt id="ST_BlipCompression">ST_BlipCompression</dt>

        <dd>

          
        </dd>


        <dt id="ST_BorderStyle">ST_BorderStyle</dt>

        <dd>

          
        </dd>


        <dt id="ST_CalcMode">ST_CalcMode</dt>

        <dd>

          
        </dd>


        <dt id="ST_CalendarType">ST_CalendarType</dt>

        <dd>

          
        </dd>


        <dt id="ST_CellComments">ST_CellComments</dt>

        <dd>

          
        </dd>


        <dt id="ST_CellFormulaType">ST_CellFormulaType</dt>

        <dd>

          
        </dd>


        <dt id="ST_CellType">ST_CellType</dt>

        <dd>

          
        </dd>


        <dt id="ST_CfType">ST_CfType</dt>

        <dd>

          
        </dd>


        <dt id="ST_CfvoType">ST_CfvoType</dt>

        <dd>

          
        </dd>


        <dt id="ST_ColorSchemeIndex">ST_ColorSchemeIndex</dt>

        <dd>

          
        </dd>


        <dt id="ST_Comments">ST_Comments</dt>

        <dd>

          
        </dd>


        <dt id="ST_CompoundLine">ST_CompoundLine</dt>

        <dd>

          
        </dd>


        <dt id="ST_ConditionalFormattingOperator">ST_ConditionalFormattingOperator</dt>

        <dd>

          
        </dd>


        <dt id="ST_CredMethod">ST_CredMethod</dt>

        <dd>

          <p><a href="RubyXL/Connections.html"><code>Connections</code></a></p>
        </dd>


        <dt id="ST_DataConsolidateFunction">ST_DataConsolidateFunction</dt>

        <dd>

          
        </dd>


        <dt id="ST_DataValidationErrorStyle">ST_DataValidationErrorStyle</dt>

        <dd>

          
        </dd>


        <dt id="ST_DataValidationImeMode">ST_DataValidationImeMode</dt>

        <dd>

          
        </dd>


        <dt id="ST_DataValidationOperator">ST_DataValidationOperator</dt>

        <dd>

          
        </dd>


        <dt id="ST_DataValidationType">ST_DataValidationType</dt>

        <dd>

          
        </dd>


        <dt id="ST_DateTimeGrouping">ST_DateTimeGrouping</dt>

        <dd>

          
        </dd>


        <dt id="ST_DvAspect">ST_DvAspect</dt>

        <dd>

          
        </dd>


        <dt id="ST_DynamicFilterType">ST_DynamicFilterType</dt>

        <dd>

          
        </dd>


        <dt id="ST_EffectContainerType">ST_EffectContainerType</dt>

        <dd>

          
        </dd>


        <dt id="ST_ExternalConnectionType">ST_ExternalConnectionType</dt>

        <dd>

          
        </dd>


        <dt id="ST_FileType">ST_FileType</dt>

        <dd>

          
        </dd>


        <dt id="ST_FilterOperator">ST_FilterOperator</dt>

        <dd>

          
        </dd>


        <dt id="ST_FontCollectionIndex">ST_FontCollectionIndex</dt>

        <dd>

          
        </dd>


        <dt id="ST_GradientType">ST_GradientType</dt>

        <dd>

          
        </dd>


        <dt id="ST_GrowShrinkType">ST_GrowShrinkType</dt>

        <dd>

          <p>Query Tables</p>
        </dd>


        <dt id="ST_HorizontalAlignment">ST_HorizontalAlignment</dt>

        <dd>

          
        </dd>


        <dt id="ST_HtmlFmt">ST_HtmlFmt</dt>

        <dd>

          
        </dd>


        <dt id="ST_IconSetType">ST_IconSetType</dt>

        <dd>

          
        </dd>


        <dt id="ST_LightRigDirection">ST_LightRigDirection</dt>

        <dd>

          
        </dd>


        <dt id="ST_LightRigType">ST_LightRigType</dt>

        <dd>

          
        </dd>


        <dt id="ST_LineCap">ST_LineCap</dt>

        <dd>

          
        </dd>


        <dt id="ST_LineEndLength">ST_LineEndLength</dt>

        <dd>

          
        </dd>


        <dt id="ST_LineEndType">ST_LineEndType</dt>

        <dd>

          
        </dd>


        <dt id="ST_LineEndWidth">ST_LineEndWidth</dt>

        <dd>

          
        </dd>


        <dt id="ST_Objects">ST_Objects</dt>

        <dd>

          
        </dd>


        <dt id="ST_OleUpdate">ST_OleUpdate</dt>

        <dd>

          
        </dd>


        <dt id="ST_Orientation">ST_Orientation</dt>

        <dd>

          
        </dd>


        <dt id="ST_PageOrder">ST_PageOrder</dt>

        <dd>

          
        </dd>


        <dt id="ST_Pane">ST_Pane</dt>

        <dd>

          
        </dd>


        <dt id="ST_PaneState">ST_PaneState</dt>

        <dd>

          
        </dd>


        <dt id="ST_ParameterType">ST_ParameterType</dt>

        <dd>

          
        </dd>


        <dt id="ST_PathFillMode">ST_PathFillMode</dt>

        <dd>

          
        </dd>


        <dt id="ST_PathShadeType">ST_PathShadeType</dt>

        <dd>

          
        </dd>


        <dt id="ST_PatternType">ST_PatternType</dt>

        <dd>

          
        </dd>


        <dt id="ST_PenAlignment">ST_PenAlignment</dt>

        <dd>

          
        </dd>


        <dt id="ST_PhoneticAlignment">ST_PhoneticAlignment</dt>

        <dd>

          
        </dd>


        <dt id="ST_PhoneticType">ST_PhoneticType</dt>

        <dd>

          
        </dd>


        <dt id="ST_PivotAreaType">ST_PivotAreaType</dt>

        <dd>

          
        </dd>


        <dt id="ST_PresetCameraType">ST_PresetCameraType</dt>

        <dd>

          
        </dd>


        <dt id="ST_PresetColorVal">ST_PresetColorVal</dt>

        <dd>

          
        </dd>


        <dt id="ST_PresetLineDashVal">ST_PresetLineDashVal</dt>

        <dd>

          
        </dd>


        <dt id="ST_PresetMaterialType">ST_PresetMaterialType</dt>

        <dd>

          
        </dd>


        <dt id="ST_PresetPatternVal">ST_PresetPatternVal</dt>

        <dd>

          
        </dd>


        <dt id="ST_PresetShadowVal">ST_PresetShadowVal</dt>

        <dd>

          
        </dd>


        <dt id="ST_PrintError">ST_PrintError</dt>

        <dd>

          
        </dd>


        <dt id="ST_Qualifier">ST_Qualifier</dt>

        <dd>

          
        </dd>


        <dt id="ST_RectAlignment">ST_RectAlignment</dt>

        <dd>

          
        </dd>


        <dt id="ST_RefMode">ST_RefMode</dt>

        <dd>

          
        </dd>


        <dt id="ST_SchemeColorVal">ST_SchemeColorVal</dt>

        <dd>

          
        </dd>


        <dt id="ST_ShapeType">ST_ShapeType</dt>

        <dd>

          
        </dd>


        <dt id="ST_SheetViewType">ST_SheetViewType</dt>

        <dd>

          
        </dd>


        <dt id="ST_SmartTagShow">ST_SmartTagShow</dt>

        <dd>

          
        </dd>


        <dt id="ST_SortBy">ST_SortBy</dt>

        <dd>

          
        </dd>


        <dt id="ST_SortMethod">ST_SortMethod</dt>

        <dd>

          
        </dd>


        <dt id="ST_SystemColorVal">ST_SystemColorVal</dt>

        <dd>

          
        </dd>


        <dt id="ST_TargetScreenSize">ST_TargetScreenSize</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextAlignType">ST_TextAlignType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextAnchoringType">ST_TextAnchoringType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextAutonumberScheme">ST_TextAutonumberScheme</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextCapsType">ST_TextCapsType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextFontAlignType">ST_TextFontAlignType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextHorzOverflowType">ST_TextHorzOverflowType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextShapeType">ST_TextShapeType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextStrikeType">ST_TextStrikeType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextTabAlignType">ST_TextTabAlignType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextUnderlineType">ST_TextUnderlineType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextVertOverflowType">ST_TextVertOverflowType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextVerticalType">ST_TextVerticalType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TextWrappingType">ST_TextWrappingType</dt>

        <dd>

          
        </dd>


        <dt id="ST_TileFlipMode">ST_TileFlipMode</dt>

        <dd>

          
        </dd>


        <dt id="ST_TimePeriod">ST_TimePeriod</dt>

        <dd>

          
        </dd>


        <dt id="ST_UnderlineValues">ST_UnderlineValues</dt>

        <dd>

          
        </dd>


        <dt id="ST_UnsignedIntHex">ST_UnsignedIntHex</dt>

        <dd>

          <p>TODO: <a href="http://www.datypic.com/sc/ooxml/t-ssml_ST_UnsignedIntHex.html">www.datypic.com/sc/ooxml/t-ssml_ST_UnsignedIntHex.html</a></p>
        </dd>


        <dt id="ST_UnsignedShortHex">ST_UnsignedShortHex</dt>

        <dd>

          
        </dd>


        <dt id="ST_UpdateLinks">ST_UpdateLinks</dt>

        <dd>

          
        </dd>


        <dt id="ST_VectorBaseType">ST_VectorBaseType</dt>

        <dd>

          
        </dd>


        <dt id="ST_VerticalAlignment">ST_VerticalAlignment</dt>

        <dd>

          
        </dd>


        <dt id="ST_Visibility">ST_Visibility</dt>

        <dd>

          
        </dd>


        <dt id="ST_WebSourceType">ST_WebSourceType</dt>

        <dd>

          
        </dd>


        <dt id="ST_Xstring">ST_Xstring</dt>

        <dd>

          
        </dd>


      </dl>
    </section>





     <section id="public-class-5Buntitled-5D-method-details" class="method-section anchor-link">
       <header>
         <h3>Public Class Methods</h3>
       </header>


      <div id="method-c-from_root" class="method-detail anchor-link ">
        <div class="method-header">

            <div class="method-heading">
              <a href="#method-c-from_root" title="Link to this method">
                <span class="method-name">from_root</span>
                <span class="method-args">(path)</span>
              </a>
            </div>

        </div>


          <div class="method-controls">
            <details class="method-source-toggle">
              <summary>Source</summary>
            </details>
          </div>



        <div class="method-description">

          <div class="method-source-code" id="from_root-source">
            <pre><span class="ruby-comment"># File lib/rubyXL.rb, line 8</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">from_root</span>(<span class="ruby-identifier">path</span>)
  <span class="ruby-keyword">return</span> <span class="ruby-identifier">path</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">absolute?</span>
  <span class="ruby-identifier">path</span>.<span class="ruby-identifier">relative_path_from</span>(<span class="ruby-constant">OOXMLTopLevelObject</span><span class="ruby-operator">::</span><span class="ruby-constant">ROOT</span>)
<span class="ruby-keyword">end</span></pre>
          </div>



          <p>Convert any path passed to absolute path (within the XLSX file).</p>


        </div>





      </div>


    </section>

  </section>

</main>
</body>

